Button (wfxButton)

Properties

Name Description
AllowDrop Gets or sets a value (true/false) indicating whether the control will accept data that is dragged onto it.
AllowFocusRect Enables or disables drawing the focus rectangle for a Button control. ThemeSupport property must be set to False.
Anchor Specifies how a control anchors to the edges of its Form.
BackColor Gets or sets the background color of the form. Refer to the Colors object.
BackColorDown Gets or sets the background color of the control when pressed. Refer to the Colors object. ThemeSupport property must be set to False.
BackColorHot Gets or sets the background hot color of the control when the mouse is over the button. Refer to the Colors object. ThemeSupport property must be set to False.
CtrlId Gets or sets a value indicating the control ID of the control.
CtrlType Gets or sets the control type value. Always ControlType.Button and used when adding control to the application’s form collection.
Enabled Gets or sets a value (true/false) indicating whether the control can respond to user interaction.
Focused Gets or sets a value (true/false) indicating whether the control has input focus.
Font Gets or sets the font for the control. Refer to the Font object.
Height Gets or sets the height of the control.
hWindow Gets the Windows handle (hwnd) of the control.
hWindowParent Gets or sets the Windows handle (hwnd) of the parent control.
Image Gets or set the image to display.
ImageAlign Gets or sets a value indicating the alignment of the image on a control. Refer to ImageAlignment enum.
ImageHighDPI Gets or sets a value (true/false) indicating whether to apply high DPI scaling to the image.
ImageHeight Gets or sets the height of the image.
ImageWidth Gets or sets the width of the image.
ImageMargin Gets or set the margin in pixels of the image.
Left Gets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area (normally the form).
Location Gets or sets the top and left position of the control. Get: returns wfxPoint object. Set: (left, top).
Locked Gets or sets a value (true/false) indicating whether the control can be moved or resized.
MultiLine Gets or sets a value (true/false) indicating whether the control can have multiline text. Embedded {br} text is converted to chr(10) linefeed.
Parent Gets or sets the parent container of the control.
Size Gets or sets the size of the form. Get: returns wfxSize object. Set: (width, height)
TabIndex Gets or sets the position that the control occupies in the TAB position.
TabStop Gets or sets a value (true/false) indicating whether the user can use the TAB key to give focus to the control.
Tag Gets or sets user defined text associated with the form.
Text Gets or sets the text (caption) associated with this form.
TextAlign Gets or sets a value indicating the alignment of the text on a control. Refer to ButtonAlignment enum.
TextBackColor Gets or sets the background color of the control. ThemeSupport property must be set to False.
TextBackColorDown Gets or sets the background color of the control when the button is pressed. ThemeSupport property must be set to False.
TextForeColor Gets or sets the foreground color of the control. ThemeSupport property must be set to False.
TextForeColorHot Gets or sets the foreground hot color of the control when the mouse is over the button. Refer to the Colors object. ThemeSupport property must be set to False.
TextForeColorDown Gets or sets the foreground color of the control when the button is pressed. ThemeSupport property must be set to False.
TextMargin Gets or sets a value indicating the margin in pixels to the text of a button control.
ThemeSupport Gets or sets a value (true/false) indicating whether Windows Theme will be applied to the control.
ToggleMode Gets or sets a value (true/false) indicating whether the button allows dual states to toggle between On and Off.
Top Gets or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area (normally the form).
UseMnemonic Gets or sets a value (true/false) indicating whether the first character preceded by an ampersand (&) character will be used as the control’s accelerator key.
Visible Gets or sets a value (true/false) indicating whether the control is displayed.
Width Gets or sets the width of the control.

Methods

Name Description
Hide Conceals the control from the user.
Refresh Forces the form to invalidate its client area and immediately redraw itself and any child controls.
SelectNextControl Moves the input control to the next (True) or previous (False) control in the tab order.
SetBounds Sets the bounds of the control to the specified location and size. SetBounds(left, top, width, height).
Show Creates and displays the control to the user.

Events

Name Description
AllEvents Special handler where all events are routed through. Use this handler if you prefer to use the Win32 api style messages and wParam and lParam parameters. Set the Handled element of EventArgs to true if you handle a message and do not want Windows to perform any further processing on the message.
Click Occurs when the client area of the control is clicked.
Destroy Occurs immediately before the control is about to be destroyed and all resources associated with it released.
DropFiles Occurs when an object is dragged and dropped onto the control and the AllowDrop property of the control is set to True.
GotFocus Occurs when the control receives focus.
LostFocus Occurs when the control loses focus.
KeyDown Occurs when a key is pressed while the control has focus.
KeyPress Occurs when a character, space or backspace key is pressed while the control has focus.
KeyUp Occurs when a key is released while the control has focus.
MouseDoubleClick Occurs when the control is double clicked by the mouse.
MouseDown Occurs when the mouse pointer is over the control and a mouse button is pressed.
MouseEnter Occurs when the mouse pointer enters the control.
MouseHover Occurs when the mouse pointer rests on the control.
MouseLeave Occurs when the mouse pointer leaves the control.
MouseMove Occurs when the mouse pointer is moved over the control.
MouseUp Occurs when the mouse pointer is over the control and a mouse button is released.
ControlBorderStyle
Enum ControlBorderStyle
   None = 1
   FixedSingle  
   Fixed3D 
End Enum
ButtonAlignment
Enum ButtonAlignment
   BottomCenter = 1
   BottomLeft   
   BottomRight  
   MiddleCenter 
   MiddleLeft   
   MiddleRight  
   TopCenter    
   TopLeft      
   TopRight     
End Enum
ImageAlignment
Enum ImageAlignment
   BottomCenter = 1
   BottomLeft   
   BottomRight  
   MiddleCenter    ' Button Text is not displayed when this is selected
   MiddleLeft   
   MiddleRight  
   TopCenter    
   TopLeft      
   TopRight     
End Enum
wfxSize
Type wfxSize
   private:
      _Width  as Long
      _Height as long 

   public:
      Declare Property Width() As Long
      Declare Property Width( ByVal nValue As Long )
      Declare Property Height() As Long
      Declare Property Height( ByVal nValue As Long )
      Declare Function IsEmpty() as Boolean
      Declare Constructor ( byval nWidth as long = 0, byval nHeight as long = 0)
End Type
wfxPoint
Type wfxPoint
   private:
      _x as Long
      _y as long 

   public:
      Declare Property x() As Long
      Declare Property x( ByVal nValue As Long )
      Declare Property y() As Long
      Declare Property y( ByVal nValue As Long )
      Declare Function IsEmpty() as Boolean
      Declare Constructor ( byval xPos as long = 0, byval yPos as long = 0)
End Type